Skip to content

chore(metrics): Add typeDoc #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Dec 14, 2021
Merged

chore(metrics): Add typeDoc #285

merged 22 commits into from
Dec 14, 2021

Conversation

flochaz
Copy link
Contributor

@flochaz flochaz commented Dec 10, 2021

depends on #277

Description of your changes

Add typedoc to code to get:

  • API documention to get generated

Screenshot 2021-12-10 at 08 02 40

  • Get mouse over doc in IDE

Screenshot 2021-12-10 at 07 56 31

How to verify this change

  1. generate API docs with npm run docs-generateApiDoc
  2. render API docs with npm run docs-runLocalApiDoc
  3. Go to http://127.0.0.1:8080/modules/_aws_lambda_powertools_metrics.html

Related issues, RFCs

#151

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi added documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility labels Dec 10, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 10, 2021
@flochaz flochaz requested a review from saragerion December 10, 2021 10:13
@dreamorosi dreamorosi self-requested a review December 10, 2021 11:44
dreamorosi
dreamorosi reviewed Dec 10, 2021
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, left some comments and suggestions around format/styling but looking good. After the beta has been published and we have the docs for all the modules we should make sure all the examples are consistent and use correct linting (spaces, single quotes, etc.).

@dreamorosi dreamorosi linked an issue Dec 10, 2021 that may be closed by this pull request
Docs: create metrics documentation #151
Closed
@dreamorosi dreamorosi mentioned this pull request Dec 12, 2021
Closed
3 tasks
@dreamorosi dreamorosi self-requested a review December 12, 2021 15:17
dreamorosi
dreamorosi previously approved these changes Dec 12, 2021
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super, thanks for kicking off this part of the documentation :)

saragerion
saragerion previously approved these changes Dec 13, 2021
View reviewed changes
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature will be super useful, thanks for adding it. Added a minor comment.

@flochaz flochaz dismissed stale reviews from saragerion and dreamorosi via 4df88d3 December 13, 2021 09:02
@flochaz flochaz force-pushed the chore/metricsTypeDoc branch from e5eb858 to 73609c1 Compare December 13, 2021 10:34
saragerion
saragerion previously approved these changes Dec 13, 2021
View reviewed changes
@flochaz flochaz requested a review from ijemmy December 13, 2021 11:26
dreamorosi
dreamorosi previously approved these changes Dec 13, 2021
View reviewed changes
ijemmy
ijemmy reviewed Dec 13, 2021
View reviewed changes
@flochaz flochaz dismissed stale reviews from dreamorosi and saragerion via 693c8a1 December 13, 2021 14:25
@flochaz flochaz mentioned this pull request Dec 13, 2021
Closed
@flochaz flochaz requested a review from ijemmy December 13, 2021 14:42
saragerion
saragerion reviewed Dec 13, 2021
View reviewed changes
@dreamorosi dreamorosi self-requested a review December 14, 2021 10:27
dreamorosi
dreamorosi approved these changes Dec 14, 2021
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge it!

saragerion
saragerion approved these changes Dec 14, 2021
View reviewed changes
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@flochaz flochaz merged commit 064c2e2 into main Dec 14, 2021
@flochaz flochaz deleted the chore/metricsTypeDoc branch December 14, 2021 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

@saragerion saragerion saragerion approved these changes

@ijemmy ijemmy Awaiting requested review from ijemmy

Assignees

@flochaz flochaz

Labels
documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility
Projects
None yet
Milestone
beta-release
Development

Successfully merging this pull request may close these issues.

Docs: create metrics documentation
4 participants
@flochaz @ijemmy @dreamorosi @saragerion